/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.hibernate.qtags;

import org.xdoclet.plugin.hibernate.qtags.parameter.*;

// Derived classes have the same property / parameter set.
// but since column must be specified in several situations ( and for the same property )
// it's necessary to split.
/**
 * Customize column mapping.
 *
 * @qtags.location method
 * @qtags.location field
 */
public interface HibernateColumnTag extends com.thoughtworks.qdox.model.DocletTag, Index, Length, NotNull, SqlType,
    Unique, Scale, Precision, Check {
    /**
     * The column name
     *
     * @qtags.required
     */
    String getName_();

    /**
     * The name of a unique constraint
     */
    String getUniqueKey();
    
    /**
     * comment for this column
     * @return
     */
    String getComment();
}